lib: Add #define for endoflife metadata key
authorRuixin <peter.bao@mail.utoronto.ca>
Fri, 21 Jul 2017 15:20:50 +0000 (15:20 +0000)
committerAtomic Bot <atomic-devel@projectatomic.io>
Fri, 21 Jul 2017 15:27:06 +0000 (15:27 +0000)
It is a continuation of https://github.com/ostreedev/ostree/pull/1024
It adds documentation for endoflife metadata key.

Closes: #1025
Approved by: cgwalters

src/libostree/ostree-core.h

index 1b0f8913678b7f8524fddef6097bc4596aaef9d0..1fef003a4d225a0a24d3fe13f07ac9dfcd97870c 100644 (file)
@@ -216,6 +216,16 @@ typedef enum {
  * Since: 2017.7
  */
 #define OSTREE_COMMIT_META_KEY_ENDOFLIFE_REBASE "ostree.endoflife-rebase"
+/**
+ * OSTREE_COMMIT_META_KEY_ENDOFLIFE:
+ *
+ * GVariant type `s`. This metadata key is used to display vendor's message
+ * when an update stream for a particular branch ends. It usually provides
+ * update instructions for the users.
+ *
+ * Since: 2017.7
+ */
+#define OSTREE_COMMIT_META_KEY_ENDOFLIFE "ostree.endoflife"
 
 _OSTREE_PUBLIC
 const GVariantType *ostree_metadata_variant_type (OstreeObjectType objtype);